home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 007 / lblcs.arc / KEY.DOC < prev    next >
Text File  |  1985-05-08  |  6KB  |  203 lines
  1. **************** interrupt driven routines *****************
  2.  
  3. ;--------------------------------------------------------------
  4. ;
  5. ; name        key_intercept - intercept hardware key interrupt
  6. ;
  7. ; synopsis    key_intercept();
  8. ;
  9. ; description    Intercepts the hardware keyboard interrupt.  You can
  10. ;        use this routine to gain absolute control over the 
  11. ;        keyboard.  The disadvantage is that you have to work
  12. ;        with scan codes directly, not nice ascii characters.
  13. ;        Up to 512 scan codes are buffered.
  14. ;
  15. ; notes
  16. ;        The key_nointercept routine MUST be called before
  17. ;        leaving your program, or the machine will hang.
  18. ;
  19. ;        You must not attempt to use any other routine that
  20. ;        reads the keyboard, or your program will hang.  This
  21. ;        routine absolutely intercepts the keyboard.
  22. ;
  23. ;        You are in control of the keyboard, but that means that
  24. ;        it is your responsibility to manage the state of the
  25. ;        shift keys, the caps lock, and numlock keys and any other
  26. ;        command keys, like the control key.
  27. ;
  28. ;        Each key returns two scan codes, one when pressed, one
  29. ;        when released.  The code returned when the key is pressed
  30. ;        is called a MAKE code, the one returned when a key is
  31. ;        released is called a BREAK code.  The BREAK code is 
  32. ;        the same as the make code, except that the high order bit
  33. ;        is set in the BREAK code.
  34. ;
  35. ;--------------------------------------------------------------     
  36.  
  37.  
  38.  
  39.  
  40. ;--------------------------------------------------------------
  41. ; name        key_nointercept - remove keyboard interception
  42. ;
  43. ; synopsis    VOID key_nointercept()
  44. ;
  45. ; description    Removes    the interrupt structure    installed by key_intercept.
  46. ;        Must be done before passing control to DOS, else your 
  47. ;        machine will hang.
  48. ;--------------------------------------------------------------
  49.  
  50.  
  51.  
  52.  
  53. ;--------------------------------------------------------------
  54. ; 
  55. ; name        key_intbcnt - Return # chars in interrupt buffer
  56. ;
  57. ; synopsis    count = key_intbcnt();
  58. ;
  59. ; description    Returns the number of scan codes available in the
  60. ;        keyboard intercept interrupt buffer.
  61. ;
  62. ; notes        Call this to make sure that there are keystrokes
  63. ;        available before attempting to read a code out of
  64. ;        the buffer.  If there are no codes available, DO NOT
  65. ;        attempt to read the buffer.
  66. ;
  67. ;--------------------------------------------------------------  
  68.  
  69.  
  70.  
  71. ;--------------------------------------------------------------
  72. ;
  73. ; name        key_intbflush - Flush the interrupt buffer.
  74. ;
  75. ; synopsis    VOID key_intbflush()
  76. ;
  77. ; description    Flushes any key strokes in the keyboard interrupt
  78. ;        intercept buffer.
  79. ;
  80. ;--------------------------------------------------------------
  81.  
  82.  
  83. ;--------------------------------------------------------------
  84. ;
  85. ; name        key_intbread - get a char from the input buffer.
  86. ;
  87. ; synopsis    ch = key_intbread();
  88. ;
  89. ; description    returns the next character from the keyboard
  90. ;        interrupt intercept buffer. Assumes you have called
  91. ;        key_intbcnt to see if there are any characters to get.
  92. ;
  93. ; notes:
  94. ;        Will probably crash if called when the buffer is
  95. ;        empty.  Call key_intbcnt first to see if there is
  96. ;        anything available to read !!!!!!!!
  97. ;
  98. ;--------------------------------------------------------------
  99.  
  100.  
  101.  
  102. **************** Non-interrupt driven routines follow ***************
  103.  
  104.  
  105.  
  106. ;--------------------------------------------------------------
  107. ;
  108. ; name        key_flush    - flush keyboard buffer
  109. ;
  110. ; synopsis    VOID    key_flush()
  111. ;
  112. ; description    Flushes (clears out) the keyboard buffer.
  113. ;
  114. ;
  115. ;--------------------------------------------------------------
  116.  
  117.  
  118.  
  119. ;--------------------------------------------------------------
  120. ;
  121. ; name        key_getch -- read a char from the keyboard
  122. ;
  123. ; synopsis    int    ch;
  124. ;        ch = key_getch();
  125. ;        scan = ch >> 8;
  126. ;        ascii = ch & 255;
  127. ;
  128. ; description    Waits for a key to be pressed on the keyboard and
  129. ;        returns the character.  Removes character from input 
  130. ;        buffer.  Returns both ASCII char and scan code.
  131. ;        scan code is in the high 8 bits, ASCII in the low 8 bits.
  132. ; Notes:
  133. ;        arrow keys and some others return only scan codes. Shift
  134. ;        keys, control keys and some others do not show up at all
  135. ;         when using this function.
  136. ;
  137. ;--------------------------------------------------------------
  138.  
  139.  
  140.  
  141.  
  142. ;--------------------------------------------------------------
  143. ; 
  144. ; name        key_scan - see if key is available from keyboard
  145. ;
  146. ; synopsis    ch = key_scan();
  147. ;
  148. ; description    Check the DOS keyboard buffer for characters available.
  149. ;        returns 0 if no characters area available, or character
  150. ;        and scan code in the same manner as key_getch().  Note
  151. ;        that this routine does not remove characters from the
  152. ;        buffer - you must use key_getch() to do that.  Several
  153. ;        calls to this routine will return the same character -
  154. ;        i.e. the first character available in keyboard buffer.
  155. ;
  156. ; Notes:
  157. ;        NOT identical to the CI-C86 library function of the 
  158. ;        same name, which returns EOF or 0xffff if no chars
  159. ;        are available.
  160. ;--------------------------------------------------------------
  161.  
  162.  
  163.  
  164.  
  165.  
  166. ;--------------------------------------------------------------
  167. ;
  168. ; name        key_shift - return shift and other indicators
  169. ;
  170. ; synopsis    int key_shift()
  171. ;
  172. ; description    Returns status of shift and other indicators.
  173. ;
  174. ;        st = key_shift();
  175. ;        The following are TRUE if Non - zero:
  176. ;
  177. ;        right_shift = st & 0x01;
  178. ;        left_shift  = st & 0x02;
  179. ;        control_key = st & 0x04;
  180. ;        alt_key     = st & 0x08;
  181. ;        scroll_lock = st & 0x10;
  182. ;        num_lock    = st & 0x20;
  183. ;        caps_lock   = st & 0x40;
  184. ;        insert_key  = st & 0x80;
  185. ;
  186. ; Notes:
  187. ;        The high byte return of this is unknown.  If you intend
  188. ;        to not use the examples shown above, mask the returned
  189. ;        value to remove the unknown:
  190. ;    
  191. ;         st = key_shift() & 255;     
  192. ;
  193. ;--------------------------------------------------------------
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.